docs(config): clarify .npmrc naming convention for environment variable overrides #8752
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MaxBlack-dev
force-pushed
the
docs/6036-npmrc-naming-convention
branch
from
cd81093 to
5a75c16
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds important documentation clarifying that custom configuration keys in .npmrc files should use hyphens instead of underscores to ensure they can be overridden by environment variables.
Changes
Fixes
Closes #6036
Rationale
Users were confused because environment variables use underscores (npm_config_some_thing) but if you define 'some_thing' in .npmrc, it can't be overridden. This happens because npm converts underscores to hyphens when reading env vars, so the env var becomes 'some-thing' but the .npmrc key remains 'some_thing'. By using hyphens in .npmrc files, both will resolve to the same key.
Type of Change